Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a "bug report" issue template #42

Merged
merged 1 commit into from
Oct 27, 2023
Merged

add a "bug report" issue template #42

merged 1 commit into from
Oct 27, 2023

Conversation

amtoine
Copy link
Owner

@amtoine amtoine commented Oct 27, 2023

description

i was trying to reproduce #40 and set $env.GIT_REPOS_HOME and $env.GIT_REPOS_CACHE to empty and unused directories and files to not mess up with my repositories.

in this PR, i propose to add an issue template for bug reports.
this is greatly inspired by the bug report of Nushell.

the template will ask for

  • a description
  • steps to reproduce: here it will be asked to define a clean reproduction environment using the following commands
const REPRO_ENV = {
    GIT_REPOS_HOME: ($nu.temp-path | path join "repos/"),
    GIT_REPOS_CACHE: ($nu.temp-path | path join "repos.cache"),
}
with-env $REPRO_ENV {
    gm status | select root.path cache.path | values | each {
        if ($in | path exists) { rm --recursive --force --verbose $in }
    }
}

and then run all the gm commands in with-env $REPRO_ENV { ... }

  • what was expected
  • the configuration of Nushell used
  • (optional) some additional information

@amtoine amtoine added documentation Improvements or additions to documentation enhancement New feature or request ci Something related to the Continuous Integration labels Oct 27, 2023
@amtoine
Copy link
Owner Author

amtoine commented Oct 27, 2023

not sure we can test that before landing... so we might just want to bet and see how it looks like 😱

@melMass
Copy link
Collaborator

melMass commented Oct 27, 2023

not sure we can test that before landing... so we might just want to bet and see how it looks like 😱

You can here, it's pretty much that minus the frontmatter:
https://github.com/amtoine/nu-git-manager/blob/add-bug-report-template/.github/ISSUE_TEMPLATE/bug_report.yml

image

@melMass melMass merged commit 6f29aa8 into main Oct 27, 2023
3 checks passed
@melMass melMass deleted the add-bug-report-template branch October 27, 2023 23:09
@amtoine
Copy link
Owner Author

amtoine commented Oct 28, 2023

@melMass
interesting to know that this renders fine 👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Something related to the Continuous Integration documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants